Schedule.registerItemClass Method (Class(?), String, Int32)

Registers a schedule item class for serialization support.

Namespace: com.mindfusion.scheduling.model
Package: com.mindfusion.scheduling.model

 Syntax

Java

public static void registerItemClass (
    Class<? extends Item> itemClass,
    String classId,
    int classVersion
)

 Parameters

itemClass

A Class instance identifying the item class.

classId

A class identifier to use when saving and loading items of the specified type.

classVersion

A revision number of the item's class serialization format.

 Remarks

When using custom item classes, use this method to enable saving and loading the custom item objects to/from XML files. The class id string is written before each item's data, and when loading items later that string indicates to the schedule what class instance to create and let it load the subsequent data. The following class identifiers are reserved and should not be used: 'std:appointment', 'std:resource', 'std:contact', 'std:location' and 'std:task'.

The version identifier must be increased when the format in which items are saved changes. It is used when loading files to let your application load items data from an older format.

Note: All custom item classes must provide a parameterless constructor. Failing to do so would result in exceptions during the load process, since the schedule will be unable to create custom items.